home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / c-lang / phnlgdvk.lha / PhoneLog / PhoneLog.txt < prev    next >
Text File  |  1996-05-07  |  6KB  |  216 lines
  1.  
  2.                       Table of Contents
  3.  
  4.    Copyright                    - Copyright information
  5.    Disclaimer                   - Legal Information
  6.    Distribution                 - Copying conditions
  7.    Support/Updates              - How to get updates and support
  8.    Author                       - How to reach the author
  9.  
  10.    Description                  - What is the PhoneLog standard?
  11.    Implementation        - How to implement PhoneLog support
  12.  
  13.    History                      - Revision history of the PhoneLog standard
  14.  
  15.  
  16.  
  17. This software is copyright 1996 by Kai Hofmann. All rights reserved!
  18.  
  19. - Permission is hereby granted, without written agreement and without license,
  20.   to USE this software and its documentation for any purpose, provided that
  21.   the above copyright notice and the following paragraph appear in all copies
  22.   of this software.
  23.  
  24.   You "must" send me a full version of your product at no cost including free
  25.   updates!
  26.  
  27.  
  28. DISCLAIMER
  29.  
  30. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  31. LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR OTHER
  32. PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  33. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  34. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
  35. QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
  36. DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  37.  
  38. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
  39. COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAM AS
  40. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  41. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  42. THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  43. INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  44. PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
  45. PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  46.  
  47. THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  48. ENHANCEMENTS, OR MODIFICATIONS.
  49.  
  50.  
  51.  
  52. Permission is hereby granted, without written agreement and without license or
  53. royalty fees, to copy and distribute this software and its documentation for
  54. any purpose, provided that the above copyright notice appear in all copies
  55. of this software.
  56.  
  57.  
  58.  
  59. Support/Updates
  60. ---------------
  61.  
  62. - Updates will be available via Aminet®
  63. - Support will be available via the authors email address
  64.  
  65.  
  66.  
  67. Author
  68. ------
  69.  
  70. Kai Hofmann
  71. Arberger Heerstraße 92
  72. 28307 Bremen
  73. Germany
  74.  
  75. Phone: (+49)-(0)421/480780
  76. EMail: i07m@zfn.uni-bremen.de
  77.        i07m@informatik.uni-bremen.de
  78. IRC  : PowerStat@#AmigaGer
  79. WWW  : http://www.informatik.uni-bremen.de/~i07m
  80.  
  81.  
  82.  
  83. Description
  84. -----------
  85.  
  86. It seems that there was no standard for log files that are used
  87. to log modem connections etc. As you can see programs like PhoneBill (by
  88. Raymond Penners) support very much different log file formats.
  89. So I decided to create a standard based on SGML (Standard Generalized Markup
  90. Language) which is defined in ISO8879 and on ISO8601 which defines date/time
  91. representations.
  92.  
  93. SGML uses the ASCII characterset as base, so it can be used on every
  94. platform. On the other hand SGML gives the log file a real structure
  95. that is defined by the DTD (Document Type Definition).
  96.  
  97. The advantage of using SGML is that these log files have a structure, so they
  98. can be easily interchanged with other SGML applications like databases,
  99. wordprocessors or calculation software.
  100.  
  101. By supporting this standard with your software you give the user the
  102. possibility to create or evaluate log files with software from
  103. different platforms; and you get a standard that is easily extended
  104. should a need occur.
  105.  
  106. To make this standard widely used, I provide a generator and a parser for
  107. this log file standard for free!
  108.  
  109.  
  110. Implementation
  111. --------------
  112.  
  113. The format of PhoneLog log files is defined by the DTD that you can find in
  114. the SGML directory - there you will also find an example of a log file
  115. (PhoneLog.sgm) and a EBNF.
  116.  
  117. For those of you who are not familar with SGML I will try to explain the
  118. basics:
  119.  
  120. In the DTD the elements for a document type will be defined. Normally all
  121. elements have a start-tag and an end-tag.
  122.  
  123. <!ELEMENT PHONELOG    - O ((ENTRY | MARK)*)>
  124.  
  125. descibes the element <PHONELOG> that consist of zero or more elements of the
  126. type <ENTRY>...</ENTRY> or <MARK>...</MARK>.
  127.  
  128. Each element can consist of other subelements or it is a final element that
  129. contains character data (CDATA).
  130. If an element has subelements, these will be defined as follows:
  131.  
  132. () : Expressions within a group are treated as a unit for other operations.
  133. ,  : All of the connected elements must occur in the same sequence as defined.
  134. |  : One and only one of the connected elements must occur.
  135. *  : Unit can occur 0 or more times.
  136. ?  : Unit can occur 0 or 1 time.
  137.  
  138. Optional some elements may have their own attributes:
  139.  
  140. <!ATTLIST PHONELOG    version        NUMBER    1
  141.             revision    NUMBER    2>
  142.  
  143. <PHONELOG> means that the defined default version/revision will be used.
  144. <PHONELOG version=1 revision=5> defines version/revision 1.5.
  145.  
  146.  
  147. A log-file entry can be freely formated:
  148.  
  149. <ENTRY><HOST><NUMBER>2187550</NUMBER></HOST><START><DATE>1995-02-15</DATE><TIME>16:30:00</TIME></START><END><TIME>17:45:10</TIME></END></ENTRY>
  150.  
  151.  
  152. <ENTRY>
  153. <HOST><NUMBER>2187550</NUMBER></HOST>
  154. <START><DATE>1995-02-15</DATE><TIME>16:30:00</TIME></START>
  155. <END><TIME>17:45:10</TIME></END>
  156. </ENTRY>
  157.  
  158.  
  159. <ENTRY>
  160. <HOST>
  161. <NUMBER>
  162. 2187550
  163. </NUMBER>
  164. </HOST>
  165. <START>
  166. <DATE>
  167. 1995-02-15
  168. </DATE>
  169. <TIME>
  170. 16:30:00
  171. </TIME>
  172. </START>
  173. <END>
  174. <TIME>
  175. 17:45:10
  176. </TIME>
  177. </END>
  178. </ENTRY>
  179.  
  180.  
  181. But this formating is preferred:
  182.  
  183. <ENTRY>
  184.   <HOST>
  185.     <NUMBER>2187550</NUMBER>
  186.   </HOST>
  187.   <START>
  188.     <DATE>1995-02-15</DATE>
  189.     <TIME>16:30:00</TIME>
  190.   </START>
  191.   <END>
  192.     <TIME>17:45:10</TIME>
  193.   </END>
  194. </ENTRY>
  195.  
  196.  
  197. The format for date/time is taken from ISO8601 and has the following form:
  198.  
  199. Time  : hh:mm:ss
  200. Date  : yyyy-mm-dd
  201. Period: hhHmmMssS
  202.  
  203.  
  204. Hopefully this is enought information for you to understand the format.
  205. For questions please feel free to send email.
  206.  
  207.  
  208.  
  209. History
  210. -------
  211.  
  212. 08.03.1996 : V1.0 -    First release on Aminet
  213. 15.03.1996 : v1.1 -    Second Aminet release (bug fixes)
  214. 07.05.1996 : V1.2 -    Third Aminet release (support for busy and
  215.                         unanswered calls + documentation)
  216.